<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>libcoap: coap_subscription_t Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr id="projectrow">
  <td id="projectalign">
   <div id="projectname">libcoap<span id="projectnumber">&#160;4.2.0</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function(){initNavTree('structcoap__subscription__t.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>

<div class="header">
  <div class="summary">
<a href="#pub-attribs">Data Fields</a>  </div>
  <div class="headertitle"><div class="title">coap_subscription_t Struct Reference<div class="ingroups"><a class="el" href="group__observe.html">Resource observation</a></div></div></div>
</div><!--header-->
<div class="contents">

<p>Subscriber information.  
 <a href="structcoap__subscription__t.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="subscribe_8h_source.html">subscribe.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:aa751cbb82d18f3d8285ef5dcaa577d47" id="r_aa751cbb82d18f3d8285ef5dcaa577d47"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structcoap__subscription__t.html">coap_subscription_t</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcoap__subscription__t.html#aa751cbb82d18f3d8285ef5dcaa577d47">next</a></td></tr>
<tr class="memdesc:aa751cbb82d18f3d8285ef5dcaa577d47"><td class="mdescLeft">&#160;</td><td class="mdescRight">next element in linked list  <br /></td></tr>
<tr class="separator:aa751cbb82d18f3d8285ef5dcaa577d47"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8bc2e1d3901d4618772278518f0cafb8" id="r_a8bc2e1d3901d4618772278518f0cafb8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structcoap__session__t.html">coap_session_t</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcoap__subscription__t.html#a8bc2e1d3901d4618772278518f0cafb8">session</a></td></tr>
<tr class="memdesc:a8bc2e1d3901d4618772278518f0cafb8"><td class="mdescLeft">&#160;</td><td class="mdescRight">subscriber session  <br /></td></tr>
<tr class="separator:a8bc2e1d3901d4618772278518f0cafb8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8c83fc8034daa9f5c88b943698eeb466" id="r_a8c83fc8034daa9f5c88b943698eeb466"><td class="memItemLeft" align="right" valign="top">unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcoap__subscription__t.html#a8c83fc8034daa9f5c88b943698eeb466">non_cnt</a>:4</td></tr>
<tr class="memdesc:a8c83fc8034daa9f5c88b943698eeb466"><td class="mdescLeft">&#160;</td><td class="mdescRight">up to 15 non-confirmable notifies allowed  <br /></td></tr>
<tr class="separator:a8c83fc8034daa9f5c88b943698eeb466"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a83676881b25552592d3cb34e6d98431a" id="r_a83676881b25552592d3cb34e6d98431a"><td class="memItemLeft" align="right" valign="top">unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcoap__subscription__t.html#a83676881b25552592d3cb34e6d98431a">fail_cnt</a>:2</td></tr>
<tr class="memdesc:a83676881b25552592d3cb34e6d98431a"><td class="mdescLeft">&#160;</td><td class="mdescRight">up to 3 confirmable notifies can fail  <br /></td></tr>
<tr class="separator:a83676881b25552592d3cb34e6d98431a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa330d1abe6d6690e0d1e7af528a02133" id="r_aa330d1abe6d6690e0d1e7af528a02133"><td class="memItemLeft" align="right" valign="top">unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcoap__subscription__t.html#aa330d1abe6d6690e0d1e7af528a02133">dirty</a>:1</td></tr>
<tr class="memdesc:aa330d1abe6d6690e0d1e7af528a02133"><td class="mdescLeft">&#160;</td><td class="mdescRight">set if the notification temporarily could not be sent (in that case, the resource's partially dirty flag is set too)  <br /></td></tr>
<tr class="separator:aa330d1abe6d6690e0d1e7af528a02133"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a56a7321ec5cc87a67fdcecd0dc8e6525" id="r_a56a7321ec5cc87a67fdcecd0dc8e6525"><td class="memItemLeft" align="right" valign="top">unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcoap__subscription__t.html#a56a7321ec5cc87a67fdcecd0dc8e6525">has_block2</a>:1</td></tr>
<tr class="memdesc:a56a7321ec5cc87a67fdcecd0dc8e6525"><td class="mdescLeft">&#160;</td><td class="mdescRight">GET request had Block2 definition.  <br /></td></tr>
<tr class="separator:a56a7321ec5cc87a67fdcecd0dc8e6525"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0a616d69d4b63843867180124541b1a8" id="r_a0a616d69d4b63843867180124541b1a8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structcoap__block__t.html">coap_block_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcoap__subscription__t.html#a0a616d69d4b63843867180124541b1a8">block2</a></td></tr>
<tr class="memdesc:a0a616d69d4b63843867180124541b1a8"><td class="mdescLeft">&#160;</td><td class="mdescRight">GET request Block2 definition.  <br /></td></tr>
<tr class="separator:a0a616d69d4b63843867180124541b1a8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a91ab09d2d6b7ac8d2cc19fcaa64a45c1" id="r_a91ab09d2d6b7ac8d2cc19fcaa64a45c1"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcoap__subscription__t.html#a91ab09d2d6b7ac8d2cc19fcaa64a45c1">token_length</a></td></tr>
<tr class="memdesc:a91ab09d2d6b7ac8d2cc19fcaa64a45c1"><td class="mdescLeft">&#160;</td><td class="mdescRight">actual length of token  <br /></td></tr>
<tr class="separator:a91ab09d2d6b7ac8d2cc19fcaa64a45c1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2945242d243578ad07362355b3e68c2d" id="r_a2945242d243578ad07362355b3e68c2d"><td class="memItemLeft" align="right" valign="top">unsigned char&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcoap__subscription__t.html#a2945242d243578ad07362355b3e68c2d">token</a> [8]</td></tr>
<tr class="memdesc:a2945242d243578ad07362355b3e68c2d"><td class="mdescLeft">&#160;</td><td class="mdescRight">token used for subscription  <br /></td></tr>
<tr class="separator:a2945242d243578ad07362355b3e68c2d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3b72fe0111f2c937d9832b2660d7e901" id="r_a3b72fe0111f2c937d9832b2660d7e901"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structcoap__string__t.html">coap_string_t</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcoap__subscription__t.html#a3b72fe0111f2c937d9832b2660d7e901">query</a></td></tr>
<tr class="memdesc:a3b72fe0111f2c937d9832b2660d7e901"><td class="mdescLeft">&#160;</td><td class="mdescRight">query string used for subscription, if any  <br /></td></tr>
<tr class="separator:a3b72fe0111f2c937d9832b2660d7e901"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Subscriber information. </p>

<p class="definition">Definition at line <a class="el" href="subscribe_8h_source.html#l00056">56</a> of file <a class="el" href="subscribe_8h_source.html">subscribe.h</a>.</p>
</div><h2 class="groupheader">Field Documentation</h2>
<a id="a0a616d69d4b63843867180124541b1a8" name="a0a616d69d4b63843867180124541b1a8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0a616d69d4b63843867180124541b1a8">&#9670;&#160;</a></span>block2</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="structcoap__block__t.html">coap_block_t</a> coap_subscription_t::block2</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>GET request Block2 definition. </p>

<p class="definition">Definition at line <a class="el" href="subscribe_8h_source.html#l00066">66</a> of file <a class="el" href="subscribe_8h_source.html">subscribe.h</a>.</p>

</div>
</div>
<a id="aa330d1abe6d6690e0d1e7af528a02133" name="aa330d1abe6d6690e0d1e7af528a02133"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa330d1abe6d6690e0d1e7af528a02133">&#9670;&#160;</a></span>dirty</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">unsigned int coap_subscription_t::dirty</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>set if the notification temporarily could not be sent (in that case, the resource's partially dirty flag is set too) </p>

<p class="definition">Definition at line <a class="el" href="subscribe_8h_source.html#l00062">62</a> of file <a class="el" href="subscribe_8h_source.html">subscribe.h</a>.</p>

</div>
</div>
<a id="a83676881b25552592d3cb34e6d98431a" name="a83676881b25552592d3cb34e6d98431a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a83676881b25552592d3cb34e6d98431a">&#9670;&#160;</a></span>fail_cnt</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">unsigned int coap_subscription_t::fail_cnt</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>up to 3 confirmable notifies can fail </p>

<p class="definition">Definition at line <a class="el" href="subscribe_8h_source.html#l00061">61</a> of file <a class="el" href="subscribe_8h_source.html">subscribe.h</a>.</p>

</div>
</div>
<a id="a56a7321ec5cc87a67fdcecd0dc8e6525" name="a56a7321ec5cc87a67fdcecd0dc8e6525"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a56a7321ec5cc87a67fdcecd0dc8e6525">&#9670;&#160;</a></span>has_block2</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">unsigned int coap_subscription_t::has_block2</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>GET request had Block2 definition. </p>

<p class="definition">Definition at line <a class="el" href="subscribe_8h_source.html#l00065">65</a> of file <a class="el" href="subscribe_8h_source.html">subscribe.h</a>.</p>

</div>
</div>
<a id="aa751cbb82d18f3d8285ef5dcaa577d47" name="aa751cbb82d18f3d8285ef5dcaa577d47"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa751cbb82d18f3d8285ef5dcaa577d47">&#9670;&#160;</a></span>next</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">struct <a class="el" href="structcoap__subscription__t.html">coap_subscription_t</a>* coap_subscription_t::next</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>next element in linked list </p>

<p class="definition">Definition at line <a class="el" href="subscribe_8h_source.html#l00057">57</a> of file <a class="el" href="subscribe_8h_source.html">subscribe.h</a>.</p>

</div>
</div>
<a id="a8c83fc8034daa9f5c88b943698eeb466" name="a8c83fc8034daa9f5c88b943698eeb466"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8c83fc8034daa9f5c88b943698eeb466">&#9670;&#160;</a></span>non_cnt</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">unsigned int coap_subscription_t::non_cnt</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>up to 15 non-confirmable notifies allowed </p>

<p class="definition">Definition at line <a class="el" href="subscribe_8h_source.html#l00060">60</a> of file <a class="el" href="subscribe_8h_source.html">subscribe.h</a>.</p>

</div>
</div>
<a id="a3b72fe0111f2c937d9832b2660d7e901" name="a3b72fe0111f2c937d9832b2660d7e901"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3b72fe0111f2c937d9832b2660d7e901">&#9670;&#160;</a></span>query</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="structcoap__string__t.html">coap_string_t</a>* coap_subscription_t::query</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>query string used for subscription, if any </p>

<p class="definition">Definition at line <a class="el" href="subscribe_8h_source.html#l00069">69</a> of file <a class="el" href="subscribe_8h_source.html">subscribe.h</a>.</p>

</div>
</div>
<a id="a8bc2e1d3901d4618772278518f0cafb8" name="a8bc2e1d3901d4618772278518f0cafb8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8bc2e1d3901d4618772278518f0cafb8">&#9670;&#160;</a></span>session</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="structcoap__session__t.html">coap_session_t</a>* coap_subscription_t::session</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>subscriber session </p>

<p class="definition">Definition at line <a class="el" href="subscribe_8h_source.html#l00058">58</a> of file <a class="el" href="subscribe_8h_source.html">subscribe.h</a>.</p>

</div>
</div>
<a id="a2945242d243578ad07362355b3e68c2d" name="a2945242d243578ad07362355b3e68c2d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2945242d243578ad07362355b3e68c2d">&#9670;&#160;</a></span>token</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">unsigned char coap_subscription_t::token[8]</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>token used for subscription </p>

<p class="definition">Definition at line <a class="el" href="subscribe_8h_source.html#l00068">68</a> of file <a class="el" href="subscribe_8h_source.html">subscribe.h</a>.</p>

</div>
</div>
<a id="a91ab09d2d6b7ac8d2cc19fcaa64a45c1" name="a91ab09d2d6b7ac8d2cc19fcaa64a45c1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a91ab09d2d6b7ac8d2cc19fcaa64a45c1">&#9670;&#160;</a></span>token_length</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">size_t coap_subscription_t::token_length</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>actual length of token </p>

<p class="definition">Definition at line <a class="el" href="subscribe_8h_source.html#l00067">67</a> of file <a class="el" href="subscribe_8h_source.html">subscribe.h</a>.</p>

</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="subscribe_8h_source.html">subscribe.h</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="structcoap__subscription__t.html">coap_subscription_t</a></li>
    <li class="footer">Generated on Fri Dec 27 2024 09:57:44 for libcoap by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8 </li>
  </ul>
</div>
</body>
</html>
